Skip to main content

RichTextField

Rich text field supports more advanced formatting capabilities. Output of this field is a JSON.
RichTextFieldProps
RichTextFieldProps
augmentEditor
(baseEditor: Editor) => | void| Editor
augmentEditorBuiltins
(editor: Editor) => | void| Editor
blockButtons
| React.ReactElement<any, | string| React.JSXElementConstructor<any>>| ToolbarButtonSpec[]| ToolbarButtonSpec[][]
className
string
defaultValue
OptionallyVariableFieldValue
description
React.ReactNode
direction
| "horizontal"| "vertical"| "vertical-reverse"| "horizontal-reverse"
display
| "inline"| "block"
distinction
EditorCanvasDistinction
evenly
boolean
field*
| string| SugarableRelativeSingleField
gap
| boolean| "padding"| "larger"| "gap"| "gutter"| DeprecatedStackSize
horizontal
boolean
inlineButtons
| ToolbarButtonSpec[]| ToolbarButtonSpec[][]
isNonbearing
boolean
label*
React.ReactNode
labelDescription
React.ReactNode
labelPosition
FieldContainerLabelPosition
onBeforeUpdate
FieldEventListenerValue<"beforeUpdate", FieldValue>
onInitialize
FieldEventListenerValue<"initialize", FieldValue>
onUpdate
FieldEventListenerValue<"update", FieldValue>
placeholder
string
plugins
BuiltinEditorPlugins[]
required
boolean
reverse
boolean
shouldDisplayInlineToolbar
() => boolean
size
Size
style
React.CSSProperties
toolbarScheme
Scheme
useLabelElement
boolean
width
| "none"| "column"| "fluid"